home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / video / vlDMBufferGetValid.z / vlDMBufferGetValid
Encoding:
Text File  |  2002-10-03  |  8.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. VVVVLLLLDDDDMMMMBBBBUUUUFFFFFFFFEEEERRRRGGGGEEEETTTTVVVVAAAALLLLIIIIDDDD((((3333ddddmmmm))))                                VVVVLLLLDDDDMMMMBBBBUUUUFFFFFFFFEEEERRRRGGGGEEEETTTTVVVVAAAALLLLIIIIDDDD((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      vlDMBufferGetValid, vlDMBufferPutValid, vlDMBufferGetVideoInfo,
  10.      vlDMBufferSetVideoInfo - VL DMbuffer management routines
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////vvvvllll....hhhh>>>>
  14.  
  15.      iiiinnnntttt vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrGGGGeeeettttVVVVaaaalllliiiidddd((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr vvvvllllSSSSeeeerrrrvvvveeeerrrr,,,, VVVVLLLLPPPPaaaatttthhhh ppppaaaatttthhhh,,,, VVVVLLLLNNNNooooddddeeee nnnnooooddddeeee,,,, DDDDMMMMbbbbuuuuffffffffeeeerrrr**** ddddmmmmbbbbuuuuffffffffeeeerrrr))));;;;
  16.      iiiinnnntttt vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrPPPPuuuuttttVVVVaaaalllliiiidddd((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr vvvvllllSSSSeeeerrrrvvvveeeerrrr,,,, VVVVLLLLPPPPaaaatttthhhh ppppaaaatttthhhh,,,, VVVVLLLLNNNNooooddddeeee nnnnooooddddeeee,,,, DDDDMMMMbbbbuuuuffffffffeeeerrrr ddddmmmmbbbbuuuuffffffffeeeerrrr))));;;;
  17.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssyyyyssss////ddddmmmmccccoooommmmmmmmoooonnnn....hhhh>>>>
  18.      iiiinnnntttt vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrGGGGeeeettttVVVViiiiddddeeeeooooIIIInnnnffffoooo((((DDDDMMMMbbbbuuuuffffffffeeeerrrr ddddmmmmbbbbuuuuffffffffeeeerrrr,,,, DDDDMMMMBBBBuuuuffffffffeeeerrrrVVVViiiiddddeeeeooooIIIInnnnffffoooo**** vvvviiiiddddiiiinnnnffffoooo))))
  19.      iiiinnnntttt vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrSSSSeeeettttVVVViiiiddddeeeeooooIIIInnnnffffoooo((((DDDDMMMMbbbbuuuuffffffffeeeerrrr ddddmmmmbbbbuuuuffffffffeeeerrrr,,,, DDDDMMMMBBBBuuuuffffffffeeeerrrrVVVViiiiddddeeeeooooIIIInnnnffffoooo**** vvvviiiiddddiiiinnnnffffoooo))))
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrGGGGeeeettttVVVVaaaalllliiiidddd returns a valid _D_M_b_u_f_f_e_r containing video data from
  23.      the specified node and path.  This call is used in video capture-type
  24.      applications where a path is set up to route image data from a source
  25.      video device node to drain memory node.
  26.  
  27.      The buffer that is returned contains one video image, either a field or a
  28.      frame.  ddddmmmmBBBBuuuuffffffffeeeerrrrMMMMaaaappppDDDDaaaattttaaaa can be used to get a pointer to the image in the
  29.      buffer.  The contents of the buffer should not be modified.
  30.  
  31.      vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrPPPPuuuuttttVVVVaaaalllliiiidddd takes a valid _D_M_b_u_f_f_e_r and sends it to the path via
  32.      the specified node.  This call is used in video playback-type
  33.      applications where a path is set up to route image data from a source
  34.      memory node to a drain video device node.
  35.  
  36.      After calling vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrPPPPuuuuttttVVVVaaaalllliiiidddd, the video library and the call both
  37.      have references to the buffer.  The contents of the buffer should not be
  38.      changed by the caller.
  39.  
  40.      vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrGGGGeeeettttVVVViiiiddddeeeeooooIIIInnnnffffoooo copies the contents of the DMBufferVideoInfo
  41.      structure associated with a DMBuffer to the address of a
  42.      DMBufferVideoInfo structure specified by the user.
  43.  
  44.      vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrSSSSeeeettttVVVViiiiddddeeeeooooIIIInnnnffffoooo copies the contents of a DMBufferVideoInfo
  45.      structure pointed to by the specified address to the DMBufferVideoInfo
  46.      structure associated with a DMBuffer.
  47.  
  48.      The DMBufferVideoInfo structure is currently defined as:
  49.  
  50.      typedef struct DMBufferVideoInfo_s {
  51.          DDDDMMMMVVVVIIIITTTTCCCCccccooooddddeeee vvvviiiittttcccc[[[[2222]]]];;;;
  52.          uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt vvvvaaaalllliiiiddddiiiinnnnffffoooo;;;;
  53.          uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ssssddddttttiiii;;;;
  54.          cccchhhhaaaarrrr ppppaaaadddd[[[[DDDDMMMMBBBBUUUUFFFF____VVVVIIIIDDDDIIIINNNNFFFFOOOO____PPPPAAAADDDD]]]];;;; }}}} DDDDMMMMBBBBuuuuffffffffeeeerrrrVVVViiiiddddeeeeooooIIIInnnnffffoooo;;;;
  55.  
  56.      #define DMBUF_VIDINFO_SIZE      96  /* size in bytes of DMBufferVideoInfo
  57.      */
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVLLLLDDDDMMMMBBBBUUUUFFFFFFFFEEEERRRRGGGGEEEETTTTVVVVAAAALLLLIIIIDDDD((((3333ddddmmmm))))                                VVVVLLLLDDDDMMMMBBBBUUUUFFFFFFFFEEEERRRRGGGGEEEETTTTVVVVAAAALLLLIIIIDDDD((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      #define DMBUF_VIDINFO_PAD  ((DMBUF_VIDINFO_SIZE) - 2*sizeof(DMVITCcode) -
  75.      2*sizeof(unsigned int))
  76.  
  77.      #define DMBUF_VIDINFO_VALID_VITC1 0x1
  78.  
  79.      #define DMBUF_VIDINFO_VALID_VITC2 0x2
  80.  
  81.      #define DMBUF_VIDINFO_VALID_SDTI  0x4
  82.  
  83.      and is included in sys/dmcommon.h header file.
  84.  
  85. MMMMAAAACCCCHHHHIIIINNNNEEEE DDDDEEEEPPPPEEEENNNNDDDDEEEENNNNCCCCIIIIEEEESSSS
  86.      When using ggggllllXXXXAAAAssssssssoooocccciiiiaaaatttteeeeDDDDMMMMPPPPbbbbuuuuffffffffeeeerrrrSSSSGGGGIIIIXXXX to pass DMbuffers between video and
  87.      OpenGL on the OOOO2222 platform, VVVVLLLL____LLLLAAAAYYYYOOOOUUUUTTTT should be set to VVVVLLLL____LLLLAAAAYYYYOOOOUUUUTTTT____GGGGRRRRAAAAPPPPHHHHIIIICCCCSSSS.
  88.      This way, the video libary will expect DMbuffers in the format used
  89.      internally by OpenGL.
  90.  
  91. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  92.      Upon successful completion, vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrGGGGeeeettttVVVVaaaalllliiiidddd returns VLSuccess and
  93.      _d_m_b_u_f_f_e_r points to a valid DMbuffer referencing video data.  Otherwise,
  94.      -1 is returned, _d_m_b_u_f_f_e_r is set to NULL and _v_l_E_r_r_n_o is set indicating the
  95.      error.  Note that _v_l_E_r_r_n_o set to _V_L_A_g_a_i_n does not indicate an error but
  96.      rather that there was no video data at the specified node when
  97.      _v_l_D_M_B_u_f_f_e_r_G_e_t_V_a_l_i_d was called.
  98.  
  99.      Upon success completion, vvvvllllDDDDMMMMBBBBuuuuffffffffeeeerrrrPPPPuuuuttttVVVVaaaalllliiiidddd returns _V_L_S_u_c_c_e_s_s, otherwise
  100.      a value of -1 is returned and _v_l_E_r_r_n_o is set indicating the error.
  101.  
  102. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  103.      vlDMPoolRegister(3dm), vlDMPoolDeregister(3dm), dmBufferAllocate(3dm),
  104.      dmBufferFree(3dm), dmBufferMapData(3dm)
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.